API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

products

Retrieves a products resource.

Retrieves a products resource.

Authorizations:
JWT
path Parameters
id
required
string

products identifier

Responses

Response samples

Content type
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "name": "string",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "inventoryEntries": [],
  • "invoiceLines": [],
  • "billLines": [],
  • "taxCustoms": [],
  • "productComponents": [],
  • "componentProducts": [],
  • "sectors": [],
  • "sku": "string",
  • "version": "string",
  • "price": "string",
  • "priceSpecial": "string",
  • "visibleStatus": true,
  • "taxable": true,
  • "country": "string",
  • "place": "string",
  • "placePrecision": "string",
  • "producible": true,
  • "newStatus": true,
  • "type": "https://example.com/",
  • "brand": "https://example.com/",
  • "supplier": "https://example.com/",
  • "weight": "string",
  • "dimensionW": "string",
  • "dimensionH": "string",
  • "dimensionD": "string",
  • "time": "string",
  • "cost": "string",
  • "additionnalProductionCost": "string",
  • "costSpecial": "string",
  • "invQtyMin": "string",
  • "invQtyMax": "string",
  • "moq": "string",
  • "packageOrder": "string",
  • "inventoryTracking": true,
  • "rentTracking": true,
  • "countedInInventory": true,
  • "shippingTracking": true,
  • "notes": "string",
  • "notesInvoice": "string",
  • "notesBill": "string",
  • "notesRent": "string",
  • "notesProduction": "string",
  • "notesInventory": "string",
  • "notesShipping": "string",
  • "translations": {
    },
  • "productOptions": [],
  • "productBuyCosts": [],
  • "productSellPrices": [],
  • "subProductOptions": [],
  • "rents": [],
  • "rentsCharged": [],
  • "unitType": "https://example.com/",
  • "unitNb": 1,
  • "supplierCode": "string",
  • "clientCode": "string",
  • "shCode": "string",
  • "reservationPeriodicity": "https://example.com/",
  • "periodicityPrecision": "string",
  • "bookable": true,
  • "discountable": true,
  • "salable": true,
  • "invoiceLineType": "https://example.com/",
  • "purchasable": true,
  • "billLineType": "https://example.com/",
  • "onDistribution": true,
  • "onWebsite": true,
  • "owningCorporation": "https://example.com/",
  • "isVariableExpense": true,
  • "isImmo": true,
  • "isConsumable": true,
  • "shortcode": "A",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "entityFiles": {
    },
  • "apiTranslations": [
    ],
  • "newTranslations": {
    },
  • "currentLocale": "string",
  • "defaultLocale": "en",
  • "toString": "string",
  • "billLinesListing": "string",
  • "customPropertiesListing": "string",
  • "invoiceLinesListing": "string",
  • "rentsListing": "string",
  • "rentsChargedListing": "string",
  • "inventoryEntriesListing": "string",
  • "applicableCost": 0,
  • "applicableCostVirtualProperty": 0,
  • "nameVirtualProperty": "string",
  • "currentTitle": "string",
  • "translationTitlePropertyName": "string",
  • "descriptionVirtualProperty": "string",
  • "applicablePrice": 0,
  • "inStock": 0,
  • "stockProgressBar": 0,
  • "productStockProgressBar": 0,
  • "stockRatio": 0,
  • "productStockRatio": 0,
  • "stockPercentage": 0,
  • "productStockPercentage": 0,
  • "correction": 0,
  • "lastInventoryEntry": "2019-08-24T14:15:22Z",
  • "correctionVirtualProperty": 0,
  • "productBuyCostsListing": "string",
  • "productSellPricesListing": "string",
  • "productOptionsListing": "string",
  • "subProductOptionsListing": "string",
  • "productComponentsListing": "string",
  • "componentProductsListing": "string",
  • "translationsListing": "string",
  • "buyablePrice": 0,
  • "buyableBasePrice": 0,
  • "discount": 0,
  • "maxProductionCapacity": 0,
  • "applicableSupplierCode": "string",
  • "applicableClientCode": "string",
  • "sectorsListing": [
    ],
  • "consumable": true,
  • "apiShortname": "string",
  • "tableName": "string",
  • "currentTranslation": "string",
  • "currentDescription": "string",
  • "translationEntityClass": null,
  • "translationDescriptionPropertyName": "string",
  • "fullEntityString": "string",
  • "anonymousToken": "string",
  • "tokenString": "string",
  • "entityMetatadaEndpoint": "string",
  • "filesListing": "string",
  • "modificationHistoryListing": "string",
  • "notesListing": "string",
  • "ownershipsListing": "string",
  • "approvalsListing": "string",
  • "fQCN": "string",
  • "uniqueId": "string",
  • "apiCustomData": null,
  • "deleted": true,
  • "taggableType": "string",
  • "taggableId": 0,
  • "taggingListing": "string",
  • "enabled": true,
  • "enabledVirtual": true,
  • "disabled": true,
  • "entityStorageFolder": "string"
}